#region License
// IRole.cs
// 
// Copyright (c) 2012 Xoqal.com
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#endregion

namespace Xoqal.Security
{
    using System;
    using System.Collections.Generic;

    /// <summary>
    /// Represents a role.
    /// </summary>
    public interface IRole
    {
        /// <summary>
        /// Gets or sets the id.
        /// </summary>
        /// <value>
        /// The id.
        /// </value>
        Guid Id { get; set; }

        /// <summary>
        /// Gets or sets the name.
        /// </summary>
        /// <value>
        /// The name.
        /// </value>
        string Name { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether this instance is built-in.
        /// </summary>
        /// <value>
        /// <c>true</c> if this instance is built-in; otherwise, <c>false</c>.
        /// </value>
        bool IsBuiltin { get; set; }

        /// <summary>
        /// Gets the roles in permissions.
        /// </summary>
        /// <value>
        /// The roles in permissions.
        /// </value>
        IEnumerable<IRolesInPermission> RolesInPermissions { get; }

        /// <summary>
        /// Gets the users.
        /// </summary>
        /// <value>
        /// The users.
        /// </value>
        IEnumerable<IUser> Users { get; }
    }
}
